Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[develop] Update SRW container docs to reflect latest container #1170

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

[develop] Update SRW container docs to reflect latest container #1170

wants to merge 8 commits into from

Conversation

EdwardSnyder-NOAA
Copy link
Collaborator

DESCRIPTION OF CHANGES:

The SRW App container was updated to work with the head of develop. This new container was built from this Dockerfile and can be found in dockerhub. The docker container was then converted to a singularity container and staged on each T1 platforms. The container passes on most T1 platforms with the exceptions being tracked in our JIRA system.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

TESTS CONDUCTED:

  • derecho.intel
  • gaea.intel
  • hera.gnu
  • hera.intel
  • hercules.intel
  • jet.intel
  • orion.intel
  • wcoss2.intel
  • NOAA Cloud (indicate which platform)
  • Jenkins
  • fundamental test suite
  • comprehensive tests (specify which if a subset was used)

DEPENDENCIES:

DOCUMENTATION:

Updates container documentation.

ISSUE:

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain).
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

LABELS (optional):

A Code Manager needs to add the following labels to this PR:

  • Work In Progress
  • bug
  • enhancement
  • documentation
  • release
  • high priority
  • run_ci
  • run_we2e_fundamental_tests
  • run_we2e_comprehensive_tests
  • Needs Cheyenne test
  • Needs Jet test
  • Needs Hera test
  • Needs Orion test
  • help wanted

CONTRIBUTORS (optional):

@MichaelLueken MichaelLueken added the documentation Improvements or additions to documentation label Jan 8, 2025
@MichaelLueken
Copy link
Collaborator

@EdwardSnyder-NOAA -

The documentation updates that you have made for the new container look good. Before I give my approval, please merge the latest HEAD of develop into your srw-container-151 branch branch. I want to make sure that the doc_tests GitHub Action successfully passes after merging the documentation fix from yesterday, then I can approve these changes. Thanks!

MichaelLueken
MichaelLueken requested changes Jan 8, 2025
View reviewed changes
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@EdwardSnyder-NOAA -

The doc_tests show that there is a warning due to SetUpPythonEnvC still being referenced on line 369. Please change this to the new SetUpCont reference. Thanks!

doc/UsersGuide/BuildingRunningTesting/ContainerQuickstart.rst Show resolved Hide resolved
MichaelLueken
MichaelLueken approved these changes Jan 8, 2025
View reviewed changes
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for modifying line 369, @EdwardSnyder-NOAA! I will now approve these changes.

@EdwardSnyder-NOAA
Copy link
Collaborator Author

Thanks for modifying line 369, @EdwardSnyder-NOAA! I will now approve these changes.

Thank you for catching this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MichaelLueken MichaelLueken MichaelLueken approved these changes

@mkavulich mkavulich Awaiting requested review from mkavulich mkavulich is a code owner

@gsketefian gsketefian Awaiting requested review from gsketefian gsketefian is a code owner

@JeffBeck-NOAA JeffBeck-NOAA Awaiting requested review from JeffBeck-NOAA JeffBeck-NOAA is a code owner

@RatkoVasic-NOAA RatkoVasic-NOAA Awaiting requested review from RatkoVasic-NOAA RatkoVasic-NOAA is a code owner

@BenjaminBlake-NOAA BenjaminBlake-NOAA Awaiting requested review from BenjaminBlake-NOAA BenjaminBlake-NOAA is a code owner

@ywangwof ywangwof Awaiting requested review from ywangwof ywangwof is a code owner

@chan-hoo chan-hoo Awaiting requested review from chan-hoo chan-hoo is a code owner

@panll panll Awaiting requested review from panll panll is a code owner

@christinaholtNOAA christinaholtNOAA Awaiting requested review from christinaholtNOAA christinaholtNOAA is a code owner

@christopherwharrop-noaa christopherwharrop-noaa Awaiting requested review from christopherwharrop-noaa christopherwharrop-noaa is a code owner

@danielabdi-noaa danielabdi-noaa Awaiting requested review from danielabdi-noaa danielabdi-noaa is a code owner

@mark-a-potts mark-a-potts Awaiting requested review from mark-a-potts mark-a-potts is a code owner

@jkbk2004 jkbk2004 Awaiting requested review from jkbk2004 jkbk2004 is a code owner

@willmayfield willmayfield Awaiting requested review from willmayfield willmayfield is a code owner

@dmwright526 dmwright526 Awaiting requested review from dmwright526 dmwright526 is a code owner

@gspetro-NOAA gspetro-NOAA Awaiting requested review from gspetro-NOAA gspetro-NOAA is a code owner

@natalie-perlin natalie-perlin Awaiting requested review from natalie-perlin natalie-perlin is a code owner

@rickgrubin-noaa rickgrubin-noaa Awaiting requested review from rickgrubin-noaa rickgrubin-noaa is a code owner

@BruceKropp-Raytheon BruceKropp-Raytheon Awaiting requested review from BruceKropp-Raytheon BruceKropp-Raytheon is a code owner

@BenKoziol-NOAA BenKoziol-NOAA Awaiting requested review from BenKoziol-NOAA BenKoziol-NOAA is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@EdwardSnyder-NOAA @MichaelLueken